home *** CD-ROM | disk | FTP | other *** search
/ Resource Library: Multimedia / Resource Library: Multimedia.iso / hypertxt / msdos / hs25 / hs.hyp < prev    next >
Text File  |  1989-05-07  |  25KB  |  878 lines

  1. .REMARK
  2. HyperShell hyperfile - Copyright (c) N.G.Taylor 1988,1989
  3. .HEADER
  4.   ~Tg$1~TG - $2 $N ~C55~TC$4  $5~TW
  5. ╒══════════════════════╡   ~Ty$9~TW   ╞═════════════════════════╕
  6. .
  7.  
  8. .FOOTER
  9. ~L21
  10.                     ~APress space bar to continue~PF+~K ~E
  11. ╘═════════════════════════════════════════════════════════════════════════════╛
  12.  F1 ~AHELP~PMHelp~E F2 ~ACONTENTS~PA@C~E F3/4 ~ABACKTRACK~PB~E F5 ~ANOTEPAD~PA@R~E F6 ~ASEARCH~PA@X?Search string~E F7 ~ATYPE FILE~PT~E F10 ~AQUIT~PQ~E
  13. .
  14. ~ANext frame~PF+~Kn~E
  15.  
  16. .REMARK
  17. Global menus, notes and scripts
  18. .
  19.  
  20. .MENU Help
  21. Selecting     |NSelecting
  22. Contents      |NContents
  23. Backtrack     |NBacktrack
  24. Select back   |NSelect back
  25. Noted Frames  |NNoted Frames
  26. Search text   |NSearch text
  27. Type File     |NType File
  28. Do action     |NDo action
  29. DOS Gateway   |NDos Gateway
  30. Quit          |NQuit
  31. Funct. keys   |NFkeys
  32. Other Keys    |NOther Keys
  33. Information   |NInfo
  34. Colour key    |NKey
  35. Noting frames |NINS
  36. Popup menus   |Npopup menu
  37. Paged lists   |NPaged list
  38. .
  39.  
  40. .NOTE Selecting
  41. Use cursor keys or mouse to move
  42.   mouse cursor to reference, or Use
  43. TAB / SHIFT TAB to move to next /
  44.   previous reference.
  45. Press LEFT mouse button or RETURN
  46.   to select reference.
  47. ------------------------------------
  48. Press RIGHT mouse button or ESCAPE
  49.  to select control ~Npopup menu~E.
  50. .
  51. .NOTE Help
  52.         F1 Key
  53.  
  54. This gives help about using the
  55. HyperShell Browser.
  56. .
  57. .NOTE Contents
  58.         F2 Key
  59.  
  60. This provides a complete ~Npaged list~E
  61. of the frames of text available,
  62. and allows selection of one of
  63. them from the list.
  64. .
  65. .NOTE Backtrack
  66.         F3 Key
  67.  
  68. This returns to the previous frame
  69. displayed, stepping back one frame at
  70. a time. The ~NF4 key~PNSelect Back~E allows you to step
  71. back any number of frames in one go.
  72. .
  73. .NOTE Select Back
  74.        F4 Key
  75.  
  76. This allows you to reselect a frame
  77. previously visited, from a ~Npaged list~E
  78. Repeated use of the NEXT FRAME
  79. facility and other selections will
  80. accumulate a large backtrack list
  81. and this may be 'unwound' to a
  82. selected point using this key.
  83. .
  84.  
  85. .NOTE Search Text
  86.         F6 Key
  87. This allows a search to be made for a
  88. text string in the document, producing
  89. a ~Npaged list~E showing the line of text
  90. containing the string and the frame
  91. within which it was found. Located
  92. frames can be selected, or noted for
  93. later viewing using the ~NINS~E key when
  94. the cursor is over their reference.
  95. Press any key during search to abort.
  96. .
  97. .NOTE Noted frames
  98.         F5 Key
  99. This key allows you to select a
  100. reference previously noted using the
  101. ~NINS~E key, from a ~Npaged list~E
  102. of noted references.
  103. .
  104. .NOTE Quit
  105.         F10 Key
  106.  
  107. This returns to the DOS prompt.
  108. .
  109. .NOTE INS
  110. Pressing the INS key when viewing a
  111. frame or when positioned over a
  112. reference will add a reference to the
  113. noted frames list, for later selection
  114. from the ~NNoted frames~E menu. The
  115. ~NDEL~E key can be used to remove noted
  116. references from the list.
  117. .
  118. .NOTE DEL
  119. The DEL key can be used
  120. to remove noted frames
  121. from the notepad list.
  122. simply position the
  123. cursor for selection
  124. and press the DEL key.
  125. .
  126. .NOTE DOS Gateway
  127.     F9 Key
  128.  
  129. If you want to temporarily suspend
  130. viewing the document, press the F9
  131. key. When you wish to return, type
  132. 'EXIT' at the DOS prompt.
  133. .
  134. .NOTE popup menu
  135. You can select from a popup menu
  136. by using the cursor keys or mouse
  137. to highlight the option to be
  138. selected, then press LEFT mouse
  139. button or RETURN (ENTER) key.
  140. Or select using function keys for
  141. F1 to F0 or shifted function keys
  142. for S1 to S0. Press RIGHT mouse
  143. button or ESCAPE key or select
  144. outside of the menu to cancel.
  145. .
  146. .NOTE Paged list
  147. Paged lists, such as the contents
  148. list, allow you to page through
  149. the list using the Pg Dn, Pg Up
  150. and Home keys. You can select a
  151. frame reference just as you do in
  152. the frame display. Some function
  153. keys may also be used in a paged
  154. list display, and depend on the
  155. list being viewed.
  156. .
  157. .NOTE Type File
  158.     F7 Key
  159. This option allows you to type
  160. a text file out a page at a time,
  161. search for a string in it, and
  162. mode to a page within it.
  163. .
  164. .NOTE Do action
  165.     F8 Key
  166. This option allows you to
  167. perform a HyperShell action
  168. directly. It is useful for
  169. trying out various action
  170. strings. Try P=2+3*5 as an
  171. example action string.
  172. .
  173.  
  174. .NOTE Key
  175. A ~Mmenu~E gives a menu.
  176. A ~Nnote~E displays a note.
  177. A ~Freference~E allows a
  178. new frame to be selected.
  179. An ~Aaction~E does some
  180. other action.
  181. An ~Iinput field~E permits some
  182. value to be entered.
  183. .
  184.  
  185. .NOTE Fkeys
  186. F1 Help            F2  Contents
  187. F3 Backtrack       F4  Select back
  188. F5 Notepad actions F6  Search text
  189. F7 Type file       F8  Do action    
  190. F9 DOS Shell       F10 Quit
  191. .
  192.  
  193. .NOTE Info
  194.    - $9 -
  195.  Frame: $1
  196.  Title: $2
  197.  File : $3
  198.  Date : $4
  199.  Time : $5
  200.  ~ABacktrack ~O2 ~PO2A;NInfo~E with $6 entries
  201.  ~AAutoref ~O4 ~PO4A;NInfo~E
  202.  ~AMenu symbols ~O1 ~PO1A;NInfo~E
  203.  Error status $? ~C32~AClear~PYah;NInfo~E
  204. .
  205.  
  206. .NOTE Other keys
  207. s    Selecting
  208. i    Info
  209. f    Function key layout
  210. g    Go to frame
  211. b    Backtrack
  212. n    Next frame
  213. q    Quit
  214. .
  215.  
  216. .SCRIPT envvar
  217. Nenvironment variable
  218. DSET
  219. .
  220.  
  221. .NOTE environment variable
  222. For details on what environment
  223. variables are, see your MSDOS
  224. manual. Type SET at the DOS
  225. prompt to see the currently
  226. set environment variables.
  227. .
  228.  
  229. .SCRIPT Onexit
  230. NThanks
  231. Q
  232. .
  233.  
  234. .NOTE Thanks
  235. Thank you for trying HyperShell.
  236. Why not try the other demonstrations
  237. and then read the Authoring Guide to
  238. see how to develop a simple hypertext
  239. system for yourself.
  240. .
  241.  
  242. .SCRIPT SETUP
  243. O#
  244. K#hMHelp
  245. K#qSOnexit
  246. K#iNInfo
  247. K#fNFkeys
  248. K#gF?Name of frame
  249. K#sNSelecting
  250. K#bB
  251. K#nF+
  252. KF1MHelp
  253. KM1HELP
  254. KF0SOnexit
  255. Vt°
  256. Vd$
  257. .
  258.  
  259. .INDEX
  260. .CHECK of
  261.  
  262. .FRAME Welcome
  263. .TITLE to HyperShell
  264. ~TG
  265. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  266. ~Tg
  267. ╓    ╖                   ╔═════╗
  268. ║    ║                   ║        ╖            ╖  ╖
  269. ║    ║                   ║        ║            ║  ║
  270. ╠═══════╣                   ╚═════╗  ║            ║  ║
  271. ║    ║  ╓    ╖  ╔════╗  ╔════╗  ╔═════     ║  ╠════╗  ╔════╗  ║  ║
  272. ║    ║  ║    ║  ║    ║  ╠════╝  ║         ║  ║    ║  ╠════╝  ║  ║
  273. ╙    ╜  ╚════╣  ╠════╝  ╚════╝  ╙       ╚═════╝  ╙    ╜  ╚════╝  ╙  ╙ tm
  274. ──────────────    ║  ║  ──────────────────────────────────────────────────────
  275.        ╚════╝  ╙
  276.  
  277. ~TrThe hypertext system that's a menu system, disk manager, help system and more!~TB
  278. ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓~TW
  279.  
  280.     HyperShell is Copyright (c) Text Technology 1988,1989
  281. .END
  282.  
  283. .CHECK Introductory frame
  284.  
  285. .FRAME Introduction
  286. .TITLE Interaction details
  287.  
  288.     Welcome to ~FHyperShell~E. Where do we go from here?
  289.  
  290.     If you have a mouse, you can use it to move the mouse cursor
  291.     around the screen to certain highlit words called references,
  292.     and press the left button to select the reference.
  293.     Select ~FMouse~E for a full description of mouse usage.
  294.  
  295.     If you don't have a mouse, you can always use the keyboard.
  296.     The cursor keys move the mouse cursor around. Press Tab
  297.     for the next highlit field and Shift/Tab for the previous one.
  298.     Press the RETURN key to select a field, or ESCAPE to cancel.
  299.     Select ~FKeyboard~E for a full description of keyboard usage.
  300.  
  301.     If you want to exit to DOS at any point, just press 'q'.
  302. .END
  303.  
  304. .FRAME HyperShell
  305. .TITLE The HyperText shell
  306.  
  307.    HyperShell can be set up to provide :-
  308.  
  309.    -    Multi-file Hypertext with ~FReferences~E of various
  310.     forms embedded in the text.
  311.    -    Help system with access to other sources of help information
  312.    -    Menuing system for control of your programs    
  313.    -    Text file viewer
  314.    -    Directory browser / file manager
  315.    -    Applications user interface prototyping with pop-up menus etc.
  316.  
  317.    See ~FAuthoring~E for details of creating a Hypershell control file.
  318.    See ~FInstallation~E for details on installing HyperShell on your system.
  319. .END
  320.  
  321. .FRAME References
  322. .TITLE Types of reference in text
  323.  
  324.     A ~FFrame~PnFrame~Kf~E reference allows you to move to a new ~Fframe~E
  325.  
  326.     A ~nNote~Kn~E reference pops up a small textual note for you
  327.  
  328.     A ~MMenu~PnMenu~Km~E reference pops up a menu for you to choose from
  329.  
  330.     A ~SScript~PnScript~Ks~E reference does a sequence of ~AAction~PnAction~Ka~Es.
  331.  
  332.     An ~AAction~PnAction~E does a single action of some sort.
  333.  
  334.     The above references all pop up notes describing their usual function,
  335.     rather than doing their normal function.
  336. .
  337. .NOTE Frame
  338.  
  339.   A frame reference allows you to
  340.   move to another frame of text.
  341.   To get back from that frame, you
  342.   can use the backtrack facility.
  343.  
  344.  
  345.   ~FMore on Frame references~PFFrame Reference~E
  346.  
  347. .NOTE Note
  348.  
  349.   A note pops up a small window
  350.   containing some information
  351.   about the word highlighted.
  352.   You are reading a note now.
  353.  
  354.   ~FMore on Notes~PFNote~E
  355.  
  356. .NOTE Menu
  357.  
  358.   A menu pops up a list of items
  359.   for you to select from. You can
  360.   cancel the selection by clicking
  361.   the mouse outside the menu or
  362.   by pressing the right mouse button
  363.  
  364.   ~FMore on Menus~PFMenu~E
  365.  
  366. .NOTE Script
  367.  
  368.   A script performs a sequence of
  369.   actions. This may do something like
  370.   displaying a series of notes, or
  371.   prompting for a number of parameters
  372.   for a command to be issued to DOS.
  373.  
  374.   ~FMore on Scripts~PFScript~E
  375.  
  376. .NOTE Action
  377.  
  378.   An action is almost anything,
  379.   including Notes, Menus,
  380.   Backtracking, Prompting, issuing
  381.   DOS commands or even Quitting.
  382.  
  383.   ~FMore on Actions~PFAction Reference~E
  384.  
  385. .FRAME Frame reference
  386. .TITLE go to a frame
  387.  
  388.     When a frame reference is selected, the ~Fframe~E selected
  389.     is displayed on the screen. Frames, or other references
  390.     may be selected from this frame to further follow up
  391.     the reference. When the necessary information has been
  392.     found, it is possible to ~Fbacktrack~E to any of the
  393.     previous frames you have seen, either one step at a time
  394.     or by selecting from the ~Alist of frames~PFbacktrack list~E you have seen.
  395.     Certain frame reference selections do not get added to
  396.     the ~Fbacktrack~E information.
  397. .END
  398.  
  399. .FRAME Note
  400. .TITLE display a note
  401.  
  402.     A note is a pop-up display of information. This
  403.     appears in a box one quarter the size of the screen.
  404.  
  405.     Whilst the note may have information highlighted in it,
  406.     this cannot be selected as for the main ~Fframe~E text.
  407.  
  408.     The note is cleared when a ~Fmouse~E button or ~Fkey~PFkeyboard~E is pressed.
  409. .END
  410.  
  411. .FRAME Menu
  412. .TITLE popup a menu
  413.  
  414.     A pop-up menu is a list of options displayed so that a
  415.     choice can be made from them. Menu options can result in
  416.     any kind of ~Faction~PFactions~E, unless the menu is used to provide the
  417.     ~Fparameter~PFdynamic menu~E for an action, in which case all options have the
  418.     same effect.
  419.  
  420.     An option is chosen by moving the mouse to the menu, and
  421.     clicking the ~Fleft~E button when the required option is highlighted.
  422.     The menu can be cancelled by pressing the ~Fright~E mouse button, or
  423.     pressing the ~Fleft~E button or any key when outside the menu.
  424.  
  425.     Certain menus contain ~FMenu symbols~E which show the kind of actions
  426.     which will be performed when the options are selected.
  427. .END
  428.  
  429. .FRAME Menu symbols
  430. .TITLE Guide to menu actions
  431.  
  432.     Some menus contain symbols to act as a guide to what the menu
  433.     actions are. These symbols are as follows:-
  434.  
  435.     ƒ    Frame                Note
  436.     ≡    Menu            ≈    Script
  437.     «    Backtrack        Ω    Quit
  438.     δ    DOS command        Σ    Direct command
  439.     ∞    Chained command    Φ    Change directory
  440.     #    Set key mapping    α    Set/test variable
  441.     º    Set option        °    Refresh screen
  442.     τ    Type file        π    Print/popup message
  443.     ≤    Open/Read file        ≥    Open/write file
  444.     ?    Do unspecified action
  445. .
  446.  
  447. .FRAME Script
  448. .TITLE perform a script
  449.  
  450.     A script is a sequence of ~Factions~E. These actions can
  451.     be any from the set of available actions. Scripts are used
  452.     for a number of purposes - to display a sequence of ~Fnote~Es,
  453.     to set up a number of parameters to perform a ~FDOS~E call,
  454.     to set up ~Fvariables~E to modify the displayed information etc.
  455. .END
  456.  
  457. .FRAME Action reference
  458. .TITLE do some action
  459.  
  460.     An action reference shows that some action is to take
  461.     place that is not one of the usual actions(~FMenu~E,
  462.     ~FNote~E, ~FFrame~E, ~FScript~E). Selecting an action
  463.     reference will have almost any effect, and hopefully
  464.     the contextual information will give you some clue as
  465.     to what it may be.
  466. .END
  467.  
  468. .FRAME Backtrack
  469. .TITLE retracing your steps
  470.  
  471.     When you have followed up a ~Freference~PFreferences~E, you may wish
  472.     to retrace your steps back to the initial text you were
  473.     reading. The backtrack capability allows you to do this.
  474.     The ~Fmain menu~E has an option called BACKTRACK, which
  475.     steps you back one frame. If you wish to go directly back
  476.     without having to do it one step at a time, the SELECT BACK
  477.     option of the ~Fmain menu~E will allow you to choose any
  478.     frame on the ~Fbacktrack list~E.
  479. .END
  480.  
  481. .FRAME Backtrack list
  482. .TITLE multiple backtrack
  483.  
  484.     The ~Fmain menu~E provides an option to select a
  485.     point in the list of text frames you have visited
  486.     to which you wish to return, 'unwinding' the list
  487.     of frames you have visited since, in the process.
  488.  
  489.     A full screen menu is presented, allowing you to
  490.     select a frame reference from the frames visited.
  491. .END
  492.  
  493. .FRAME Main menu
  494. .TITLE general control menu for HyperShell
  495.  
  496.     When you are viewing a text frame, you may request
  497.     a general menu for controlling HyperShell, by
  498.     pressing either the ~Fright~E mouse button or the
  499.     ESCAPE key on the ~Fkeyboard~E.
  500.  
  501.     This menu presents a number of options.
  502. .END
  503.  
  504. .FRAME Control options
  505. .TITLE choices on the main menu
  506.  
  507.     The main menu offers the following options:-
  508.  
  509.     ~FHOME~E (or ~FHELP~E)    -    Go to home frame (or give help)
  510.     ~FCONTENTS~E    -    List contents of current file for selection
  511.     ~FBACKTRACK~E    -    Backtrack one frame
  512.     ~FSELECT BACK~PFbacktrack list~E    -    List backtrack list for selection
  513.     ~FNOTEPAD~E    -    List noted actions for selection
  514.     ~FSEARCH~E        -    Search current file for text string
  515.     ~FTYPE FILE~E    -    Type contents of text file
  516.     ~FDO ACTION~E    -    Allow action to be directly requested
  517.     ~FDOS SHELL~E    -    Provide ~FDOS~E command subshell
  518.     ~FEXIT TO DOS~E    -    Exit directly to ~FDOS~E
  519. .
  520. .END
  521.  
  522. .FRAME HOME
  523. .TITLE Initial frame in hyperfile
  524.  
  525.     The HOME frame is the first ~Fframe~E in a ~Fhyperfile~E, and
  526.     generally provides some kind of lead-in to the browsing
  527.     of the hyperfile. It is useful to return to the home
  528.     frame if you appear to be lost. The ~Fcontents~E list and
  529.     the ~Fbacktrack~E list are also useful when this happens.
  530. .
  531.  
  532. .FRAME HELP
  533. .TITLE Provide help menu
  534.  
  535.     The HELP menu is usually invoked by pressing the '?' key,
  536.     although some hyperfiles may map the first control menu
  537.     action (and the F1 key) to it.
  538.  
  539.     The help menu is an application specific set of information
  540.     and will usually offer a number of note displays describing
  541.     the application provided by the hyperfile. 
  542. .
  543. .FRAME Next
  544. .TITLE move to next frame
  545.  
  546.     This option displays the next ~Fframe~E in the hyperfile.
  547.     This may not be logically connected with the current
  548.     ~Fframe~E, but the option is provided for sequential
  549.     browsing. Return to the current frame is possible if
  550.     ~Fbacktracking~PFbacktrack~E is enabled.
  551. .END
  552.  
  553. .FRAME DOS SHELL
  554. .TITLE permit DOS commands
  555.  
  556.     This option permits a ~FDOS~E shell to be executed to allow
  557.     commands to be entered at the command line.
  558.  
  559.     When you wish to return to ~FHyperShell~E, enter the EXIT
  560.     command to the ~FDOS~E command processor.
  561. .END
  562.  
  563. .FRAME CONTENTS
  564. .TITLE list contents of HyperFile
  565.  
  566.     This command lists the contents of the current ~Fhyperfile~E.
  567.     The list is displayed a page at a time, and a selection
  568.     can be made from the highlighted ~Fframe~E names, using the
  569.     usual ~Freference~PFreferences~E selection mechanism.
  570. .END
  571.  
  572. .FRAME DO ACTION
  573. .TITLE perform action directly
  574.  
  575.     This option permits an ~Faction~PFactions~E command to be entered
  576.     directly. An example action would be to perform a ~FDOS~E
  577.     command such as DIR /W by entering the ~Faction~PFactions~E :-
  578.  
  579.         DDIR /W
  580.  
  581.     Actions may have ~Faction modifiers~E to supply parametric
  582.     information.
  583. .END
  584.  
  585. .FRAME NOTEPAD
  586. .TITLE List noted actions for selection
  587.  
  588.     This option lists the references added to the notepad
  589.     list, and permits them to be selected and followed.
  590.  
  591.     During this paged display, the entries on display can
  592.     be removed from the notepad by pressing the Del key on
  593.     the keypad when the mouse cursor is positioned over the
  594.     item. All occurrences of the reference in the notepad
  595.     will be removed.
  596. .END
  597.  
  598. .FRAME SEARCH
  599. .TITLE Search current file for text string
  600.  
  601.     This option prompts for a search string and then
  602.     searches the title and text of all frames in the
  603.     current hyperfile for occurrences of the string.
  604.  
  605.     All occurrences are listed, followed by the frame name
  606.     and title containing the search string.
  607.  
  608.     The search is a case sensitive search - uppercase and
  609.     lowercase characters are searched as entered.
  610. .END
  611.  
  612. .FRAME EXIT TO DOS
  613. .TITLE exit from HyperShell
  614.  
  615.     This action exits immediately from ~FHyperShell~E.
  616.     No confirmation is sought before doing this.
  617. .END
  618.  
  619. .FRAME TYPE FILE
  620. .TITLE list contents of text file
  621.  
  622.     The contents of the specified file are listed. The listing is
  623.     presented a page at a time, and certain keys may be used for
  624.     ~nmovement~E up and down the file. Other ~nkeys~E are used for
  625.     control purposes. Pressing the ~Fleft~E ~Fmouse~E button or the
  626.     RETURN key returns to the frame display, where subsequent selection
  627.     of the TYPE FILE option returns to the file at the current point.
  628.     Pressing the END button terminates the file display. The ~Fright~E
  629.     ~Fmouse~E button or ESCAPE terminates the display and any current
  630.     script being processed.
  631. .NOTE movement
  632. The ~TrPg Up~Ty key moves to the previous
  633. page of text, if any. The ~TrPg Dn~Ty key
  634. (and other keys) moves to the next page
  635. of text. The ~TrHome~Ty key moves to the
  636. start of the file.
  637. The ~Tr/~Ty key allows a search to be
  638. made for a string.
  639. The ~Tr#~Ty key allows a page number
  640. to be entered, and the page displayed.
  641. .NOTE keys
  642. The left mouse button or RETURN key
  643. returns to the frame display, allowing
  644. subsequent return to the file display.
  645. The END key terminates the file display.
  646. The ESCAPE key or right mouse button
  647. terminates the file display and any
  648. other script processing being done.
  649. .END
  650.  
  651. .FRAME Variables
  652. .TITLE variable strings
  653.  
  654.     There are two classes of variable:-
  655.  
  656.     application variables
  657.         these may be set by the HyperShell application
  658.  
  659.     system variables
  660.         these are set by HyperShell itself
  661.  
  662.     Both may be expanded in the text
  663. .END
  664.  
  665. .FRAME Actions
  666. .TITLE Commands for control of QuickText
  667.     The Main HyperShell control actions are:-
  668.  
  669.     Backtrack one or more frames
  670.     Chain execution of a program (not returning to HS)
  671.     Execute ~FDOS~E shell or command
  672.     Go to another frame
  673.     Change the current directory
  674.     Map a key to an action
  675.     Popup a menu
  676.     Popup a note
  677.     Set a control option
  678.     Quit to ~FDOS~E
  679.     Run a script
  680.     Type a file a page at a time
  681.     Set an applications variable
  682.     Execute a command and return to HyperShell
  683.     Pop up a message, and either wait for a press or not
  684. .END
  685.  
  686. .FRAME Action modifiers
  687. .TITLE Supplying action parameters
  688.  
  689.     An action may have its parameter supplied in some indirect
  690.     fashion:-
  691.  
  692.     As the result of prompting you for it.
  693.  
  694.     As the value of a DOS ~Senvironment variable~PSenvvar~E.
  695.  
  696.     As a value selected from a ~Fdynamic menu~E.
  697.  
  698.     As a line read from a file.
  699. .END
  700.  
  701. .FRAME Dynamic menu
  702. .TITLE Types of menu to supply parameters
  703.  
  704.     A dynamic menu is one presented during the course of
  705.     some other action. It is one of the following:-
  706.  
  707.     Global/local ~Fmenu~E, as for text ~Freferences~E.
  708.     Contents of a file as a menu
  709.     ~FBacktrack list~E as a menu
  710.     The current ~FHyperfile~E ~Fcontents~E list as a menu
  711.     Current directory listing, with or without the file extension.
  712.     Detailed directory listing, with or without auto-actions.
  713.     Notepad reference display, showing contents of notepad.
  714.     File listing
  715.     Search results listing
  716. .END
  717.  
  718. .FRAME Installation
  719. .TITLE Configuring Hypershell
  720.  
  721.     By default, HyperShell accesses the control files from
  722.     the current directory. This is all very well for demos
  723.     and ~Fauthoring~E, but not very useful when you want to
  724.     access HyperShell as a help system, or as a menuing
  725.     system, when you can be practically anywhere in the
  726.     directory structure. To use HyperShell, you only have to
  727.     put it in a directory which is on your ~Fpath~PFPATH^MSDOS~E.
  728.     To pick up the control files, you should put them all in
  729.     a directory somewhere, and ~Fset~PFset^msdos~E the ~Senvironment variable~PSenvvar~E
  730.     associated with HyperShell, called HSPATH, to contain the
  731.     ~npath prefix~E for the directory. For example:-
  732.  
  733.     SET HSPATH=C:\HYPSHELL\
  734. .NOTE path prefix
  735. The path prefix should contain the
  736. pathname of the directory, and
  737. should include the drive specifier
  738. at the start and a '\' at the end.
  739. .END
  740.  
  741. .FRAME Authoring
  742. .TITLE creating hypershell control files
  743.  
  744.     HyperShell is driven by a control file.
  745.     This is a simple text file, and can be edited with
  746.     a word processor or a text editor. This file is also known
  747.     as a ~Fhyperfile~E.
  748. .END
  749.  
  750. .FRAME hyperfile
  751. .TITLE HyperShell control file
  752.  
  753.     The HyperShell system is controlled by a file called a
  754.     hyperfile. This is a simple text file, and can be
  755.     easily set up from a text document by using a text editor
  756.     or a word processor. Producing a hyperfile is known as
  757.     ~FAuthoring~E.
  758.  
  759.     A hyperfile contains a number of ~Fframe~Es, each of which
  760.     can be displayed on the screen.
  761. .
  762. .FRAME frame
  763. .TITLE unit of display
  764.  
  765.     A frame is a unit of textual information containing references,
  766.     which is displayed during the normal operation of HyperShell.
  767.     What you are reading now is a frame called 'frame'.
  768.  
  769.     Frames generally fit on one screen, but it is possible that
  770.     they could be split onto two or more screenfuls. A list
  771.     of frames in a ~Fhyperfile~E is given in a ~Fcontents~E listing.
  772. .
  773.  
  774. .FRAME Mouse
  775. .TITLE Using a mouse
  776.  
  777.     If you have a mouse compatible with HyperShell installed on
  778.     your system, with a mouse driver installed, the block cursor
  779.     should respond when you push your mouse about. If it is not
  780.     compatible, or if you do not have the driver installed, it
  781.     will have no effect. In this case, see the ~Fkeyboard~E
  782.     instructions for details of keyboard control of HyperShell.
  783.  
  784.     The mouse buttons should be mapped to the following keys
  785.  
  786.     ~Fleft~E    -    RETURN key (this has a <-' on it usually)
  787.  
  788.     ~Fright~E    -    ESCAPE key
  789. .
  790. .END
  791.  
  792. .FRAME left
  793. .TITLE left mouse button
  794.  
  795.     The left mouse button, and the RETURN key, both have the
  796.     same action. This is generally to select an item over
  797.     which the ~Fmouse~E cursor is positioned.
  798.  
  799.     When viewing a text file, requested by the ~FTYPE FILE~E
  800.     option from the ~Fmain menu~E, this selection returns to
  801.     the frame display, on a temporary basis.
  802. .
  803. .END
  804.  
  805. .FRAME right
  806. .TITLE right mouse button
  807.  
  808.     The right ~Fmouse~E button has two main uses:-
  809.  
  810.     To request the ~Fmain menu~E to control HyperShell,
  811.     when viewing a text frame. This facility is not
  812.     available at other times.
  813.  
  814.     To cancel an operation which is in progress and
  815.     awaiting some input.
  816. .
  817. .END
  818.  
  819. .FRAME DOS
  820. .TITLE MSDOS
  821.  
  822.     DOS is the operating system you most likely are using now.
  823.     If you aren't, congratulations and let me know.
  824.  
  825.     DOS is a universal abbreviation for Disk Operating System.
  826.     On the PC, it is a short version of PC-DOS or MS-DOS.
  827. .END
  828.  
  829. .FRAME Keyboard
  830. .TITLE Using the keyboard
  831.  
  832.     The keyboard may be used in ~FHyperShell~E in a number of ways.
  833.  
  834.     The ~Fcursor keys~E and others can be used when viewing ~Fpaged displays~E.
  835.  
  836.     The ~FFunction keys~E can generally be used for control functions,
  837.     and the unshifted function keys are mapped to the actions provided
  838.     on the ~Fmain menu~E. Mapping these keys will alter the main menu
  839.     (special names can also be mapped to alter the menu selection
  840.     text for these - see the authoring guide).
  841.  
  842.     The RETURN and ESCAPE key have the same purpose as the ~Fleft~E
  843.     and the ~Fright~E mouse buttons.
  844.  
  845.     The remaining keys can be mapped for control purposes or
  846.     selection of ~Freferences~E.
  847. .END
  848.  
  849. .FRAME Function Keys
  850. .TITLE Direct control actions
  851.  
  852.     The function keys, when used without the shift keys,
  853.     are mapped to the main menu actions. Pressing ESCAPE,
  854.     or the right mouse button, will bring up the ~Fmain menu~E
  855.     to show the available control actions.
  856.  
  857. .END
  858.  
  859. .FRAME Cursor Keys
  860. .TITLE Selection cursor movement
  861.  
  862.     The cursor keys are used to move the mouse cursor, which
  863.     may be positioned to enable selection for a ~Freference~PFreferences~E, or
  864.     a choice on a ~Fmenu~E.
  865.  
  866. .END
  867.  
  868. .FRAME Paged displays
  869. .TITLE .TITLE
  870.  
  871.     Paged displays are used to display various lists that may
  872.     occupy more than one screenful. Certain keys are available
  873.     during a paged display. The keys available depend on the
  874.     particular paged display, and are described in detail in
  875.     the User Guide.
  876. .END
  877.  
  878.